﻿//-----------------------------------------------------------------------
// <copyright file="CommandIdMessage.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Editor.Command
{
    using System;
    using TileTool.Message;

    /// <summary>
    /// Base class for all scene based messages.
    /// </summary>
    public class CommandIdMessage : MessageBase
    {
        #region Constructors - Protected

        /// <summary>
        /// Default constructor.
        /// </summary>
        public CommandIdMessage()
        {
        }

        /// <summary>
        /// Construct the message from another message.
        /// </summary>
        /// <param name="src">Source message.</param>
        protected CommandIdMessage(CommandIdMessage src)
            : base(src)
        {
            this.Command = src.Command;
        }

        #endregion

        #region Properties - Public

        /// <summary>
        /// Gets or sets the command for the message.
        /// </summary>
        public CommandId Command
        {
            get;
            set;
        }

        /// <summary>
        /// Gets the params for the command ID message.
        /// 
        /// Params for a command ID are defined on a type by type basis.
        /// </summary>
        public object[] Params
        {
            get;
            private set;
        }

        #endregion

        #region Methods - Public

        /// <summary>
        /// Create a copy of this message.
        /// </summary>
        /// <returns>Returns a copy of this message.</returns>
        public override MessageBase Clone()
        {
            CommandIdMessage clone = new CommandIdMessage(this);

            clone.Params = this.Params;

            return clone;
        }

        /// <summary>
        /// Validate the contents of the message to ensure that all required
        /// fields are set.
        /// 
        /// Should throw an InvalidOperationException if the state of the message
        /// is not valid.
        /// </summary>
        public override void Validate()
        {
            base.Validate();

            if (this.Command == null)
            {
                throw new InvalidOperationException("Command must be non-null.");
            }
        }

        /// <summary>
        /// Set the parameters for the message.
        /// </summary>
        /// <param name="args">PArameters for the message.</param>
        public void SetParams(params object[] args)
        {
            this.Params = args;
        }

        #endregion
    }
}
